Run Studio on a VM using Docker & Docker Compose files

Customise the Docker Compose file

The Docker Compose file is a YAML file that contains the configuration for the Business Studio, including the image to use, the ports to expose, and the environment variables to set.

A sample Docker Compose file definition is provided in Appendix B, but you may need to customise it to suit your environment.

info

This config assumes that the services will share a common network, called proxy, and that the Business Studio will be accessible via a reverse proxy.

studio-compose.yml

services:

  # One37 Business Studio

  studio:
    image: [provided-image-registryhost]/studiofe/prod:latest
    container_name: studio
#   We don't have to expose ports directly as the nginx proxy will handle this.
#   Uncomment if you have an external reverse proxy.
#    ports:
#      - '8084:8084'
    networks:
      - db
      - proxy
    restart: always
    pull_policy: always
    environment:
      - ASPNETCORE_ENVIRONMENT=Production
      - MINIMUM_LOG_LEVEL=1
      - SERVICE_ROOT=http://0.0.0.0:8084
      - STUDIO_PG_HOST=[your-db-host-or-container]
      - STUDIO_PG_PORT=[your-db-port]
      - STUDIO_PG_USER=[your-db-user]
      - STUDIO_PG_PSWD=[your-db-password]
      - STUDIO_PG_DBNAME=[your-db-name]

networks:
  db:
    external: true
    name: db
  proxy:
    external: true
    name: proxy

Start the Business Studio

To start the Business Studio, run the following command in the same directory as the Docker Compose file:

docker compose -f studio-compose.yml up -d

This will start the Business Studio in the background.

tip

For the first time, you may want to run the command without the -d flag to see the output from the Business Studio and check for any errors.

tip

You can check the status of the Business Studio by running docker ps and looking for the studio container.

warning

Depending on your user permissions, you may need to prefix docker commands with sudo or run them as the root user.